<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class FreshBooks_Element</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/AbstractClass_logo.png"
														alt="Abstract Class"
														title="Abstract Class"
														style="vertical-align: middle"> FreshBooks_Element</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An abstract class representing a an XML data block</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Element.php.html">/Element.php</a> (line <span class="field">16</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em; white-space: nowrap">
						<img src="../media/images/AbstractClass.png"
								 alt="Abstract class"
								 title="Abstract class"
								 style="vertical-align: center"/>
						<a href="../FreshBooks/FreshBooks_ElementAction.html">FreshBooks_ElementAction</a>
					</td>
					<td>
											An abstract class representing a an XML data block, with create/update/delete/get/list actions
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$lastError" title="details" class="var-name">$lastError</a>
				</div>
																<div class="var-title">
					<img src="../media/images/Variable.png" alt=" " />
					<span class="var-type">mixed</span>
					<a href="#$_elementName" title="details" class="var-name">$_elementName</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#loadXML" title="details" class="method-name">loadXML</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$xml</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#_getTagXML" title="details" class="method-name">_getTagXML</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$excludeIfEmpty</span> = <span class="var-default">true</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/AbstractMethod.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#_internalLoadXML" title="details" class="method-name">_internalLoadXML</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$XMLObject</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#_processResponse" title="details" class="method-name">_processResponse</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$XMLObject</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#_requestEnvelope" title="details" class="method-name">_requestEnvelope</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methodName</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#_sendRequest" title="details" class="method-name">_sendRequest</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methodName</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$lastError" id="$lastError"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$lastError</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">26</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">holds last error text</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$_elementName" id="$_elementName"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<img src="../media/images/Variable.png" />
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_elementName</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">21</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">main xml tag name for particular instance</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../FreshBooks/FreshBooks_Estimate.html#var$_elementName">FreshBooks_Estimate::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Invoice.html#var$_elementName">FreshBooks_Invoice::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Recurring.html#var$_elementName">FreshBooks_Recurring::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Category.html#var$_elementName">FreshBooks_Category::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Client.html#var$_elementName">FreshBooks_Client::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Expense.html#var$_elementName">FreshBooks_Expense::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Item.html#var$_elementName">FreshBooks_Item::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Payment.html#var$_elementName">FreshBooks_Payment::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Project.html#var$_elementName">FreshBooks_Project::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Staff.html#var$_elementName">FreshBooks_Staff::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Task.html#var$_elementName">FreshBooks_Task::$_elementName</a>
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_TimeEntry.html#var$_elementName">FreshBooks_TimeEntry::$_elementName</a>
							</li>
				</ul>
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodloadXML" id="loadXML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">loadXML</span> (line <span class="line-number">31</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">loads XML string</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			loadXML
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$xml</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$xml</span>			</li>
				</ul>
		
			
	</div>
<a name="method_getTagXML" id="_getTagXML"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_getTagXML</span> (line <span class="line-number">43</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">construct simple xml element</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_getTagXML
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$excludeIfEmpty</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$tag</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$value</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$excludeIfEmpty</span>			</li>
				</ul>
		
			
	</div>
<a name="method_internalLoadXML" id="_internalLoadXML"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/AbstractMethod.png" />
		<span class="method-title">_internalLoadXML</span> (line <span class="line-number">38</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">internal hook to be implemented in child classes with particular logic how to populate object properties from xml</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_internalLoadXML
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$XMLObject</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$XMLObject</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../FreshBooks/FreshBooks_BaseInvoice.html#method_internalLoadXML">FreshBooks_BaseInvoice::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Estimate.html#method_internalLoadXML">FreshBooks_Estimate::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Invoice.html#method_internalLoadXML">FreshBooks_Invoice::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Recurring.html#method_internalLoadXML">FreshBooks_Recurring::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Category.html#method_internalLoadXML">FreshBooks_Category::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Client.html#method_internalLoadXML">FreshBooks_Client::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Expense.html#method_internalLoadXML">FreshBooks_Expense::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Item.html#method_internalLoadXML">FreshBooks_Item::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Payment.html#method_internalLoadXML">FreshBooks_Payment::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Project.html#method_internalLoadXML">FreshBooks_Project::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Staff.html#method_internalLoadXML">FreshBooks_Staff::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_Task.html#method_internalLoadXML">FreshBooks_Task::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
					<li>
				<a href="../FreshBooks/FreshBooks_TimeEntry.html#method_internalLoadXML">FreshBooks_TimeEntry::_internalLoadXML()</a>
								: load obect properties from SimpleXML object
							</li>
				</ul>
	</div>
<a name="method_processResponse" id="_processResponse"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_processResponse</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">processes response xml</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_processResponse
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$XMLObject</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$XMLObject</span>			</li>
				</ul>
		
			
	</div>
<a name="method_requestEnvelope" id="_requestEnvelope"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_requestEnvelope</span> (line <span class="line-number">54</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">add common tags to a request</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_requestEnvelope
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methodName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$content</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$methodName</span>			</li>
				</ul>
		
			
	</div>
<a name="method_sendRequest" id="_sendRequest"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">_sendRequest</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">send request to the server</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_sendRequest
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$methodName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$content</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$methodName</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Sat, 14 Mar 2009 18:57:54 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>